CygNet Studio > Using CygNet Studio Tools and Controls > Compass Tool > ActiveX Properties

Compass Tool - ActiveX Properties

The Compass Tool is an ActiveX control. As such, a Compass Tool object has an ActiveX page on the Property Sheet. Many of these properties are the object’s formatting properties. Values for the ActiveX Properties can be set directly on the ActiveX page or in the OCX Properties dialog box, which is accessed by clicking the (OCXProperties) property.

Property Description Related Properties

AutoFrameRate

Specifies whether the object controls its update rate. Default is 0 - No. When set to 1 - Yes, the object is repainted at the rate specified by the UpdateFrameRate property.

UpdateFrameRate

BackGroundColor

Specifies the color of the object background. Default is gray (RGB 236.233.216). The background color is not shown if the Transparent property is set to 1 - Yes.

BorderStyle

Specifies the border style of the object. Default is 0 - ibsNone. Other options are 1 - ibsRaised and 2 - ibsLowered.

 

CachedDrawing

Enables optimizing the display of the compass. Default is 1 - Yes.

 

Direction

Specifies the default direction of the pointer in relation to 360 degrees. Default is 0. If the object is associated with a point, the point’s value sets the direction.

 

DirectionDisplayFont

Specifies the directional display font. Default is MS Sans Serif (10 point bold).

DirectionDisplayFontColor

Specifies the directional display font color. This value is shown numerically in the center of the compass. Default is black (RGB 0.0.0).

DirectionDisplayPrecision

Specifies the precision of the Direction value. Default is 1.

Direction

ECaption

Specifies the caption for 90 degrees. Default is E.

Enabled

Enables user interaction with the object. If set to 0 - No, the object is still shown but its context menu is disabled. Default is 1 - Yes.

 

Height

Specifies the height (in pixels) of the object.

 

NCaption

Specifies the caption for 0 (360) degrees. Default is N.

NECaption

Specifies the caption for 45 degrees. Default is NE.

NWCaption

Specifies the caption for 315 degrees. Default is NW.

OptionSaveAllProperties

Enables the SaveAllPropertiesToFile method to save just the ActiveX Properties or all object properties. Default is 0 - No, which means that only ActiveX Properties are saved.

 

OuterBevelWidth

Specifies the width (in pixels) for the compass bevel. Default is 5.

 

OuterMargin

Specifies the margin (in pixels) of the margin between the pointer and object boundary. Default is 5.

 

PointerColor

Specifies the color of the directional pointer. Default is yellow (RGB 255.255.0).

 

PointerMargin

Specifies the width (in pixels) of the margin between the center and the compass edge. Default is 1.

 

PointerSize

Specifies the size (in pixels) of the pointer size. Default is 12.

 

PointerStyle

Specifies the style of the pointer. Default is 0 - icpsTriangle. Other options are 1 - icpsCircle and 2 - icpsLine.

 

ScaleBackGroundColor

Specifies the background color of the compass face. Default is blue (RGB 0.0.128).

[AlarmElement]

SCaption

Specifies the caption for 180 degrees. Default is S.

SECaption

Specifies the caption for 135 degrees. Default is SE.

ShowDirectionDisplay

Enables display of the directional value in the center of the compass. Default is 1 - Yes.

SWCaption

Specifies the caption for 225 degrees. Default is SW.

TickColor

Specifies the color of the tick marks on the compass face. Default is cyan (RGB 0.255.255).

[AlarmElement]

TickLabelFont

Specifies the directional display font. Default is MS Sans Serif (8 point bold).

TickLabelFontColor

TickLabelFontColor

Specifies the directional display font. Default is white (RGB 255.255.255).

TickLabelFont

TickLabelInnerMargin

Specifies the margin (in pixels) the space between the tick marks and the dial labels. Default is 10. A smaller margin results in a larger centerpiece and vice-versa.

 

TickLabelOuterMargin

Specifies the margin (in pixels) the space between the tick marks and the outer edge of the compass face. Default is 8. A smaller margin results in a larger centerpiece and vice-versa.

 

TickLength

Specifies the length (in pixels) of the tick marks. Default is 6.

 

TickMargin

Specifies the size of the margin (in pixels) between the tip of the pointer and the tick marks. Default is 0.

 

TickWidth

Determines the width (in pixels) of the tick marks. Default is 1

 

Transparent

Enables transparency of the object background. Default is 0 - No.

 

UpdateFrameRate

Specifies the rate (in seconds) of repainting the object. Default is 60. Applicable only when AutoFrameRate is set to 1 - Yes.

AutoFrameRate

Visible

Enables the visibility of the object on TheView. Default is 1 - Yes.

 

WCaption

Specifies the caption for 90 degrees. Default is W.

Width

Specifies the width (in pixels) of the object.

 
Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.